<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<title>RoomEnvironment - Three.js Docs</title>
	<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
	<script src="../scripts/highlight.min.js"></script>
	<link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
	<link type="text/css" rel="stylesheet" href="../styles/page.css">
</head>
<body>
		<p class="inheritance" translate="no"><a href="EventDispatcher.html">EventDispatcher</a> → <a href="Object3D.html">Object3D</a> → <a href="Scene.html">Scene</a> → </p>
	<h1 translate="no">RoomEnvironment</h1>
		<section>
			<header>
				<div class="class-description"><p>This class represents a scene with a basic room setup that can be used as
input for <a href="PMREMGenerator.html#fromScene">PMREMGenerator#fromScene</a>. The resulting PMREM represents the room's
lighting and can be used for Image Based Lighting by assigning it to <a href="Scene.html#environment">Scene#environment</a>
or directly as an environment map to PBR materials.</p>
<p>The implementation is based on the <a href="https://github.com/google/model-viewer/blob/master/packages/model-viewer/src/three-components/EnvironmentScene.ts" target="_blank" rel="noopener">EnvironmentScene</a>
component from the <code>model-viewer</code> project.</p></div>
				<h2>Code Example</h2>
				<div translate="no"><pre><code class="language-js">const environment = new RoomEnvironment();
const pmremGenerator = new THREE.PMREMGenerator( renderer );
const envMap = pmremGenerator.fromScene( environment ).texture;
scene.environment = envMap;
</code></pre></div>
			</header>
			<article>
				<h2 class="subsection-title">Import</h2>
				<p><span translate="no">RoomEnvironment</span> is an addon, and must be imported explicitly, see <a href="https://threejs.org/manual/#en/installation" target="_blank" rel="noopener">Installation#Addons</a>.</p>
				<pre><code class="language-js">import { RoomEnvironment } from 'three/addons/environments/RoomEnvironment.js';</code></pre>
				<div class="container-overview">
					<h2>Constructor</h2>
					<h3 class="name name-method" id="RoomEnvironment" translate="no">new <a href="#RoomEnvironment">RoomEnvironment</a><span class="signature">()</span> </h3>
					<div class="method">
					</div>
				</div>
				<h2 class="subsection-title">Methods</h2>
					<h3 class="name name-method" id="dispose" translate="no">.<a href="#dispose">dispose</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Frees internal resources. This method should be called
when the environment is no longer required.</p>
						</div>
					</div>
				<h2 class="subsection-title">Source</h2>
				<p>
					<a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/environments/RoomEnvironment.js" translate="no" target="_blank" rel="noopener">examples/jsm/environments/RoomEnvironment.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>